<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
<!-- qdoc-minimum-qdocconf.qdoc -->
  <title>A Minimal qdocconf File | QDoc Manual 5.14.2</title>
  <link rel="stylesheet" type="text/css" href="style/offline-simple.css" />
  <script type="text/javascript">
    document.getElementsByTagName("link").item(0).setAttribute("href", "style/offline.css");
    // loading style sheet breaks anchors that were jumped to before
    // so force jumping to anchor again
    setTimeout(function() {
        var anchor = location.hash;
        // need to jump to different anchor first (e.g. none)
        location.hash = "#";
        setTimeout(function() {
            location.hash = anchor;
        }, 0);
    }, 0);
  </script>
</head>
<body>
<div class="header" id="qtdocheader">
  <div class="main">
    <div class="main-rounded">
      <div class="navigationbar">
        <table><tr>
<td ><a href="../qtdoc/index.html">Qt 5.14</a></td><td ><a href="qdoc-index.html">QDoc Manual</a></td><td >A Minimal qdocconf File</td></tr></table><table class="buildversion"><tr>
<td id="buildversion" width="100%" align="right"><a href="qdoc-index.html">Qt 5.14.2 Reference Documentation</a></td>
        </tr></table>
      </div>
    </div>
<div class="content">
<div class="line">
<div class="content mainContent">
<div class="sidebar"><div class="sidebar-content" id="sidebar-content"></div></div>
<h1 class="title">A Minimal qdocconf File</h1>
<span class="subtitle"></span>
<!-- $$$qdoc-minimum-qdocconf.html-description -->
<div class="descr"> <a name="details"></a>
<p>Below you will find the full contents of qtgui.qdocconf. The subsequent section will discuss every statement in the qdocconf file.</p>
<p>Each line from the qdocconf file is first quoted. Below each statement you will find the meaning.</p>
<pre class="cpp plain">

  include(compat.qdocconf)
  outputdir   = html
  headerdirs  = .
  sourcedirs  = .
  exampledirs = .
  imagedirs   = ./images

</pre>
<p><b>Notes</b>:</p>
<pre class="cpp plain">

  include(compat.qdocconf)

</pre>
<p>For compatibility with older versions of QDoc, it is recommended to include compat.qdocconf.</p>
<pre class="cpp">

  outputdir   <span class="operator">=</span> html

</pre>
<p>QDoc will put the documentation generated in the html directory.</p>
<pre class="cpp plain">

  headerdirs  = .

</pre>
<p>The header file associated with the <i>.cpp</i> source files can be found in the current directory.</p>
<pre class="cpp plain">

  sourcedirs  = .

</pre>
<p>The current directory is the directory containing the source files: the <i>.cpp</i> and <i>.qdoc</i> files used in the documentation.</p>
<pre class="cpp plain">

  exampledirs = .

</pre>
<p>The source code of the example files can be found in the current directory.</p>
<pre class="cpp plain">

  imagedirs   = ./images

</pre>
<p>The image files can be found in the underlying directory <code>images</code>.</p>
</div>
<!-- @@@qdoc-minimum-qdocconf.html -->
        </div>
       </div>
   </div>
   </div>
</div>
<div class="footer">
   <p>
   <acronym title="Copyright">&copy;</acronym> 2020 The Qt Company Ltd.
   Documentation contributions included herein are the copyrights of
   their respective owners.<br/>    The documentation provided herein is licensed under the terms of the    <a href="http://www.gnu.org/licenses/fdl.html">GNU Free Documentation    License version 1.3</a> as published by the Free Software Foundation.<br/>    Qt and respective logos are trademarks of The Qt Company Ltd.     in Finland and/or other countries worldwide. All other trademarks are property
   of their respective owners. </p>
</div>
</body>
</html>
